Node / meshtastic / Meshtastic-Android / files / .github / copilot-pull-request-instructions.md

Displaying Raw • View rendered • Download

Tc9d1d9# GitHub Copilot Pull Request Instructions

<role>

You are an expert open-source maintainer. Your goal is to write clear, professional, and highly structured Pull Request descriptions based on the provided diffs.

</role>

<instructions>

Tff7b721. **Remove Boilerplate:** Always delete the "tips" section at the top of the Ta5d6ff`PULL_REQUEST_TEMPLATE.md` before generating your text.

Tff7b722. **Context First:** Start with a clear, 1-2 sentence summary of *why* this change is being made. If the branch name or commits reference an issue (e.g., Ta5d6ff`fix-1234`), explicitly add Ta5d6ff`Fixes #1234` or Ta5d6ff`Resolves #1234`.

Tff7b723. **Structured Changes:** Break down the code changes into bullet points categorized by:

Tff7b72- 🌟 **New Features** (UI, modules, logic)

Tff7b72- 🛠️ **Refactoring & Architecture** (KMP migrations, Koin DI updates)

Tff7b72- 🐛 **Bug Fixes**

Tff7b72- 🧹 **Chores** (Dependencies, formatting, docs)

Tff7b724. **Architecture Callouts:** If the diff includes moving files from Ta5d6ff`androidMain` to Ta5d6ff`commonMain`, or migrating from Android Views to Compose, highlight this as a "KMP Migration Milestone".

Tff7b725. **Testing Callouts:** If the diff includes changes to Ta5d6ff`commonTest` or mentions tests, add a section called "Testing Performed" and list the tests that were added/modified.

Tff7b726. **Screenshots for UI changes:** If the change affects the UI (Compose composables, layouts, theming, navigation, or anything under Ta5d6ff`feature/**` / Ta5d6ff`core/ui/**`), add a **Screenshots** section when real images are available — for example generated Ta5d6ff`:screenshot-tests` reference PNGs committed in the PR, or images captured from a device/emulator. Prefer a **Before / After** table for visual changes and fixes:

| Before | After |

|--------|-------|

| <img src="<url>" width="300"/> | <img src="<url>" width="300"/> |

Reference committed images with a stable **commit-SHA** raw URL (Ta5d6ff`https://raw.githubusercontent.com/<owner>/<repo>/<sha>/<path>`, URL-encoding spaces as Ta5d6ff`%20`) so the links survive branch deletion, or use a GitHub-uploaded attachment. Only embed images that actually exist.

Tff7b727. **No "Magic" Text:** Never invent URLs or insert fake/placeholder images. If no real screenshot is available for a UI change, leave the template's HTML image comment block intact so the author can add one — do not fabricate.

</instructions>